Executing it</h3> <ul> <li> <code>$item = $phad->item('item/name', ['key'=>'value']);</code>: load a phad item</li> <li> <code>$item->html()</code>: return a string of the finished item</li> <li>EXPERIMENTAL, pass <code>':data'=>'NAME'</code> in arguments to specify the name of a <code>p-data</code> node to use. Declare attribute <code>name="NAME"</code> on the <code><p-data></code> node to match. This usage may change in future versions.</li> <li>DEPRECATED, pass <code>'data.name'=>'NAME'</code> to do the same a <code>:data</code> </li> </ul> <h3>Just, other stuff</h3> <ul> <li> <code>$phad->exit_on_redirect = false</code> to stop redirects from <code>exit</code>ing</li> </ul> <h3>Basics / Item Nodes / Some forms tuff</h3> <ul> <li>Ex: <code><div item="Blog"></code> </li> <li>Ex: <code><h1 prop="title"></code> inside the blog item div</li> <li>Variables available: <code>object $Blog</code>, <code>array $BlogRow</code>, <code>stdClass $BlogInfo</code> ... there's more ... see your compiled output</li> <li> <code><h1 prop="title" filter="html_escape"></code> to apply <code>html_escape</code> filter before dispalying title. (see filter documentation)</li> <li>add <code>loop="inner"</code> to loop INSIDE the div (so the div only displays once, but it's content shows for each row)</li> <li>pass <code>['Blog'=>$Blog]</code> or <code>['BlogList'=>[$Blog1, $Blog2]]</code> to use that as data (skips access checks, since it uses the default data node)</li> <li> <code><x-item item="Blog"></code> ... works like any other item node, except <code>x-item</code> will hide itself</li> <li> <code><x-prop prop="body"></x-prop></code> to display <code>$Blog->body</code> without showing an html node</li> <li>override certain methods on Phad to further customize things ....</li> <li>delete <code>Filter</code> controller. I'm not using it ... but it might be in some tests? ... phad just directly handles filters now</li> </ul> <h3>Phad Overrides</h3> <p>Of course, you can override any part of Phad ...</p> <ul> <li> <code>function object_from_row(array $row, $ItemInfo): object</code> (default returns <code>(object)$ItemRow</code>) <ul> <li>Custom object can add properties with <code><p prop="some_prop"></code> without the prop being in the db</li> </ul> </li> <li> <code>function onSubmit($ItemInfo, &$ItemRow): bool</code>, return <code>false</code> to stop submission</li> <li> <code>function onDidSubmit($ItemInfo, $ItemRow)</code>, called after a successful submission to do extra work</li> <li> <code>function onWillDelete($ItemInfo): bool</code>, return <code>false</code> to stop deletion</li> </ul> <h3>Phad Handlers</h3> <p>Set <code>$phad->handlers['handler_name'] = function(...$args){}</code> ... then <code>$phad->handler_name()</code> will call that function. The function name can be anything, just need any callable.</p> <ul> <li>'can_read_row' (optional): <code>function can_read_row(array $ItemRow,object $ItemInfo,string $ItemName): bool</code> ... returns true by default</li> <li>'item_initialized' (required?): <code>function item_initialized(stdClass $ItemInfo): void</code> </li> <li>'user_has_role' (required?): <code>function user_has_role(string $roles): bool</code> where <code>$roles</code> should be like <code>guest|admin|moderator</code> (though that's up to you & how you define your role access in attribute handlers)</li> </ul> <h3>Routes</h3> <ul> <li> <code><route pattern="/some/route/"></route></code> </li> <li> <code><route pattern="/some/{slug}/></route>"</code> for dynamic routes. Requires a data node like <code><p-data where="Blog.slug LIKE :slug"></p-data></code> </li> <li>You can have multiple <code><route></code> nodes in a single file & each can have a <code><sitemap></code> node</li> </ul> <h3>Sitemaps</h3> <ul> <li>Goes inside a <code><route></code> node. Can use dynamic patterns</li> <li>For <code><route pattern="/some/{slug}/"</code>: <code><sitemap sql="SELECT slug FROM blog"></code> ...</li> <li>The <code><sitemap</code> node can declare attributes and/or the sql can select <code>priority</code>, <code>lastmod</code>, and <code>changefreq</code> </li> <li>@todo <code><sitemap handler="handler_name"</code> points to <code>$phad->sitemap->handlers['handler_name']</code> and ... idk ... feature not implemented yet</li> <li>@todo allow individual route sitemapping like For <code><route pattern="/some/route/"</code>: <code><sitemap></sitemap></code> ... hack this by setting <code>sql="SELECT 1 as one</code> on the sitemap node ...</li> </ul> <h3>Property filters</h3> <ul> <li>Ex: <code><p prop="description" filter="my_filter"></code> yields <code><p><?=$phad->filter($Blog->description)?></p></code> </li> <li> <code>commonmark:markdownToHtml</code> uses <code>"league/commonmark": "^1.0"</code> ... for now ... which you have to add to your composer.json bc the dependency is in <code>require-dev</code> for this package</li> <li>add other filters with <code>$phad->filters['filter_name'] = function($property_value){}</code> </li> </ul> <h3><code><on></code> nodes</h3> <ul> <li>if one <code><p-data></code> node is granted, then only the successful's <code>200</code> status will be displayed</li> <li>if no <code><p-data></code> nodes are granted, then each data node's <code><on></code> node will display ... showing 403, 404, 500, etc ... depending what the error was for that node</li> <li>what about <code><on></code> nodes not nested in <code><p-data></code>? I'm not sure.</li> </ul> <h3><code><p-data></code> nodes</h3> <ul> <li>must be direct child of an item node</li> <li> <code>sql</code> attribute to craft a full query. (you can use multiple lines inside the double quotes)</li> <li> <code>where</code>, <code>limit</code>, <code>orderby</code>, and <code>cols</code> attributes to refine if not using <code>sql</code> attribute. do not include the sql verb inside the double quotes</li> <li> <code>access</code> attribute used to limit access. See the docs on attribute call handlers</li> <li> <code>if</code> attribute may contain php code such as <code>isset($some_var)</code>. This code will be <code>eval</code>'d & if it returns false, then this data node will not be used.</li> <li> <code>data_loader="some_key"</code> can be used to load data by defining <code>$phad->data_loaders["some_key"] = function(DomNode, ItemInfo)</code>.</li> </ul> <h3>Hook Nodes</h3> <p>all hook nodes can contain php code, html, whatever. For a better understanding of these, use them & look at the compiled output. the submit nodes are all for forms only.</p> <ul> <li> <code><onsubmit>php code</code>: Set <code>$ItemInfo->mode = null</code> to stop submission or modify <code>$ItemRow</code> to change what gets submitted</li> <li> <code><didsubmit>php code</code> </li> <li> <code><failsubmit> php code</code> </li> <li> <code><diddelete> php code</code>: for code to run only AFTER the database row is deleted</li> <li> <code><willdelete> php code</code>: For code to run BEFORE the database row is deleted</li> <li> <code><on s=404|403|500|200> php code</code> ... as direct child of <code><p-data></code> or direct child of <code><div item="Blog"></code> </li> </ul> <h3>Attribute Call Handlers</h3> <p>cansubmit, candelete, and diddelete all go on <code><form item="Blog"></code> nodes.</p> <p>These take strings like <code>role:moderator;call:handler_name</code>. Access handlers should return <code>true/false</code>. Hook handlers (<code>diddelete</code>) do not need to return anything.</p> <p>For <code>handler_name</code>, do <code>$phad->access_handlers['handler_name'] = function(...$args){}</code></p> <ul> <li> <code>cansubmit</code>: <code>function(stdClass $ItemInfo, array $RowToStore): bool</code> </li> <li> <code>candelete</code>: <code>function(stdClass $ItemInfo): bool</code> </li> <li> <code>diddelete</code>: <code>function(stdClass $ItemInfo): void</code> </li> <li> <code><button access="call:can_do_buttons"></code>: <code>function(array $node_info): bool</code> (for <code>can_read_node()</code>) ... <code>$node_info</code> is the html node's attributes + <code>tagName</code> </li> <li> <code><p-data access="call:is_data_allowed"></code>: <code>function(array $data_node_info, stdClass $ItemInfo): bool</code> where <code>$data_node_info</code> is the html node's attributes + <code>tagName</code> </li> </ul> <h3>Forms</h3> <ul> <li>add <code>target="/blogs/{slug}/"</code> to form node to automatically redirect after submission. the slug will be filled in by the submitted row</li> <li>See hook nodes & attribute call handlers</li> <li>To delete a field request <code>/page/?phad_action=delete&id=ID_TO_DELETE</code> </li> <li>To enable deletion, add <code>candelete</code> attribute to form. If empty, there will be no checks & deletion will always succeed. <code>candelete="false"</code> declines deletion. <code>candelete='role:admin'</code> or <code>candelete="call:your_func"</code> for checks (see Attribute Call handlers)</li> <li> <code><errors></errors></code> node as direct child of the form will automatically display errors in a div with <code>class="errors"</code> and each message is in a <code><p></code> with no class.</li> <li>in your attribute call handlers, do <code>$Info->submit_errors[] = ['msg'=>"Some Message"];</code> to display in the <code><errors></code> node</li> <li>set <code>$Info->cancel_submit = true</code> to prevent a submission.</li> <li>manually displaying errors ... <code><?php foreach($ItemInfo->submit_errors as $m){echo $m['msg'];}</code> <ul> <li>Or you can use the items feature: <code><div item="ItemSubmitErrors"><p prop="msg"></p></div></code> ... this method may be removed. idk. it isn't tested</li> </ul> </li> <li>file uploads: Kinda meh, see below</li> <li> <code>backend</code> inputs: <code><input type="backend" name="slug"></code> ... You might use <code><onsubmit></code> to convert a title into a slug. To store the slug in the db, add <code>$BlogRow['slug'] = $the_slug</code> & the <code>backend</code> input so it passes validation. backend inputs are removed from the html.</li> <li>@TODO <code><input type="hidden" name="id"></code> is added automatically</li> <li>For inputs added via php (thus not in the html when compiled by phad), add to the onsubmit <code>$ItemInfo->properties['prop'] => ['type'=>'text','tagName'=>'input']</code>. You may change the type or add other attributes that exist for form inputs (such as <code>minlength</code>/<code>maxlength</code>, or <code>required</code>). the <code>tagName=>'input'</code> part is necessary for validation.</li> <li>For submitted fields that you DON'T want in the database, do <code>unset($ItemRow['field'])</code> & in some cases <code>unset($ItemInfo->properties['field'])</code> in your <code><onsubmit></code> code</li> </

Executing it

$item = $phad->item('item/name', ['key'=>'value']);: load a phad item
$item->html(): return a string of the finished item
EXPERIMENTAL, pass ':data'=>'NAME' in arguments to specify the name of a p-data node to use. Declare attribute name="NAME" on the <p-data> node to match. This usage may change in future versions.
DEPRECATED, pass 'data.name'=>'NAME' to do the same a :data

Just, other stuff

$phad->exit_on_redirect = false to stop redirects from exiting

Basics / Item Nodes / Some forms tuff

Ex: <div item="Blog">
Ex: <h1 prop="title"> inside the blog item div
Variables available: object $Blog, array $BlogRow, stdClass $BlogInfo ... there's more ... see your compiled output
<h1 prop="title" filter="html_escape"> to apply html_escape filter before dispalying title. (see filter documentation)
add loop="inner" to loop INSIDE the div (so the div only displays once, but it's content shows for each row)
pass ['Blog'=>$Blog] or ['BlogList'=>[$Blog1, $Blog2]] to use that as data (skips access checks, since it uses the default data node)
<x-item item="Blog"> ... works like any other item node, except x-item will hide itself
<x-prop prop="body"></x-prop> to display $Blog->body without showing an html node
override certain methods on Phad to further customize things ....
delete Filter controller. I'm not using it ... but it might be in some tests? ... phad just directly handles filters now

Phad Overrides

Of course, you can override any part of Phad ...

function object_from_row(array $row, $ItemInfo): object (default returns (object)$ItemRow)
- Custom object can add properties with <p prop="some_prop"> without the prop being in the db
function onSubmit($ItemInfo, &$ItemRow): bool, return false to stop submission
function onDidSubmit($ItemInfo, $ItemRow), called after a successful submission to do extra work
function onWillDelete($ItemInfo): bool, return false to stop deletion

Phad Handlers

Set $phad->handlers['handler_name'] = function(...$args){} ... then $phad->handler_name() will call that function. The function name can be anything, just need any callable.

'can_read_row' (optional): function can_read_row(array $ItemRow,object $ItemInfo,string $ItemName): bool ... returns true by default
'item_initialized' (required?): function item_initialized(stdClass $ItemInfo): void
'user_has_role' (required?): function user_has_role(string $roles): bool where $roles should be like guest|admin|moderator (though that's up to you & how you define your role access in attribute handlers)

Routes

<route pattern="/some/route/"></route>
<route pattern="/some/{slug}/></route>" for dynamic routes. Requires a data node like <p-data where="Blog.slug LIKE :slug"></p-data>
You can have multiple <route> nodes in a single file & each can have a <sitemap> node

Sitemaps

Goes inside a <route> node. Can use dynamic patterns
For <route pattern="/some/{slug}/": <sitemap sql="SELECT slug FROM blog"> ...
The <sitemap node can declare attributes and/or the sql can select priority, lastmod, and changefreq
@todo <sitemap handler="handler_name" points to $phad->sitemap->handlers['handler_name'] and ... idk ... feature not implemented yet
@todo allow individual route sitemapping like For <route pattern="/some/route/": <sitemap></sitemap> ... hack this by setting sql="SELECT 1 as one on the sitemap node ...

Property filters

Ex: <p prop="description" filter="my_filter"> yields <p><?=$phad->filter($Blog->description)?></p>
commonmark:markdownToHtml uses "league/commonmark": "^1.0" ... for now ... which you have to add to your composer.json bc the dependency is in require-dev for this package
add other filters with $phad->filters['filter_name'] = function($property_value){}

`<on>` nodes

if one <p-data> node is granted, then only the successful's 200 status will be displayed
if no <p-data> nodes are granted, then each data node's <on> node will display ... showing 403, 404, 500, etc ... depending what the error was for that node
what about <on> nodes not nested in <p-data>? I'm not sure.

`<p-data>` nodes

must be direct child of an item node
sql attribute to craft a full query. (you can use multiple lines inside the double quotes)
where, limit, orderby, and cols attributes to refine if not using sql attribute. do not include the sql verb inside the double quotes
access attribute used to limit access. See the docs on attribute call handlers
if attribute may contain php code such as isset($some_var). This code will be eval'd & if it returns false, then this data node will not be used.
data_loader="some_key" can be used to load data by defining $phad->data_loaders["some_key"] = function(DomNode, ItemInfo).

Hook Nodes

all hook nodes can contain php code, html, whatever. For a better understanding of these, use them & look at the compiled output. the submit nodes are all for forms only.

<onsubmit>php code: Set $ItemInfo->mode = null to stop submission or modify $ItemRow to change what gets submitted
<didsubmit>php code
<failsubmit> php code
<diddelete> php code: for code to run only AFTER the database row is deleted
<willdelete> php code: For code to run BEFORE the database row is deleted
<on s=404|403|500|200> php code ... as direct child of <p-data> or direct child of <div item="Blog">

Attribute Call Handlers

cansubmit, candelete, and diddelete all go on <form item="Blog"> nodes.

These take strings like role:moderator;call:handler_name. Access handlers should return true/false. Hook handlers (diddelete) do not need to return anything.

For handler_name, do $phad->access_handlers['handler_name'] = function(...$args){}

cansubmit: function(stdClass $ItemInfo, array $RowToStore): bool
candelete: function(stdClass $ItemInfo): bool
diddelete: function(stdClass $ItemInfo): void
<button access="call:can_do_buttons">: function(array $node_info): bool (for can_read_node()) ... $node_info is the html node's attributes + tagName
<p-data access="call:is_data_allowed">: function(array $data_node_info, stdClass $ItemInfo): bool where $data_node_info is the html node's attributes + tagName

Forms

add target="/blogs/{slug}/" to form node to automatically redirect after submission. the slug will be filled in by the submitted row
See hook nodes & attribute call handlers
To delete a field request /page/?phad_action=delete&id=ID_TO_DELETE
To enable deletion, add candelete attribute to form. If empty, there will be no checks & deletion will always succeed. candelete="false" declines deletion. candelete='role:admin' or candelete="call:your_func" for checks (see Attribute Call handlers)
<errors></errors> node as direct child of the form will automatically display errors in a div with class="errors" and each message is in a <p> with no class.
in your attribute call handlers, do $Info->submit_errors[] = ['msg'=>"Some Message"]; to display in the <errors> node
set $Info->cancel_submit = true to prevent a submission.
manually displaying errors ... <?php foreach($ItemInfo->submit_errors as $m){echo $m['msg'];}
- Or you can use the items feature: <div item="ItemSubmitErrors"><p prop="msg"></p></div> ... this method may be removed. idk. it isn't tested
file uploads: Kinda meh, see below
backend inputs: <input type="backend" name="slug"> ... You might use <onsubmit> to convert a title into a slug. To store the slug in the db, add $BlogRow['slug'] = $the_slug & the backend input so it passes validation. backend inputs are removed from the html.
@TODO <input type="hidden" name="id"> is added automatically
For inputs added via php (thus not in the html when compiled by phad), add to the onsubmit $ItemInfo->properties['prop'] => ['type'=>'text','tagName'=>'input']. You may change the type or add other attributes that exist for form inputs (such as minlength/maxlength, or required). the tagName=>'input' part is necessary for validation.
For submitted fields that you DON'T want in the database, do unset($ItemRow['field']) & in some cases unset($ItemInfo->properties['field']) in your <onsubmit> code

Taeluf.com

Executing it

Just, other stuff

Basics / Item Nodes / Some forms tuff

Phad Overrides

Phad Handlers

Routes

Sitemaps

Property filters

`<on>` nodes

`<p-data>` nodes

Hook Nodes

Attribute Call Handlers

Forms

Choose a Branch

Executing it

Just, other stuff

Basics / Item Nodes / Some forms tuff

Phad Overrides

Phad Handlers

Routes

Sitemaps

Property filters

<on> nodes

<p-data> nodes

Hook Nodes

Attribute Call Handlers

Forms

Choose a Branch

`<on>` nodes

`<p-data>` nodes